home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 2: Applications / Linux Cubed Series 2 - Applications.iso / editors / emacs / xemacs / xemacs-1.006 / xemacs-1 / lib / xemacs-19.13 / lisp / README < prev    next >
Encoding:
Text File  |  1995-05-26  |  4.4 KB  |  132 lines
  1.  
  2. The subdirectories of this directory contain source code for the XEmacs
  3. facilities written in Emacs Lisp.  *.el files are Elisp source, and *.elc
  4. files are byte-compiled versions of the corresponding *.el files.
  5. Byte-compiled files are architecture-independent.
  6.  
  7. When XEmacs starts up, it adds all subdirectories of the site-lisp
  8. directory.  The site-lisp directory normally exists only in
  9. installation trees.  For more information about the site-lisp
  10. directory see the NEWS file.
  11.  
  12. After XEmacs adds all subdirectories of the site-lisp directory, it
  13. adds all subdirectories of this directory to the load-path (the list
  14. of directories to be searched when loading files.)  To speed up this
  15. process, this directory has been rearranged to have very few files at
  16. the top-level, so that emacs doesn't have to stat() several hundred
  17. files to find the dozen or so which are actually subdirectories.
  18.  
  19. Directories whose names begin with "-" or "." are not added to the default
  20. load-path.
  21.  
  22. The only files which remain at top-level are those which you might
  23. reasonably want to alter when installing or customizing XEmacs at your
  24. site.  The files which may appear at top level are:
  25.  
  26.     paths.el    You may need to change the default pathnames here,
  27.             but probably not.  This is loaded before XEmacs is
  28.             dumped.
  29.  
  30.     site-init.el    To pre-load additional libraries into XEmacs and dump
  31.             them in the executable, load them from this file.
  32.  
  33.     site-load.el    This is like site-init.el, but if you want the 
  34.             docstrings of your preloaded libraries to be kept in
  35.             the DOC file instead of in the executable, you should
  36.             load them from this file instead.  To do this, you must
  37.             also cause them to be scanned when the DOC file is
  38.             generated by editing ../src/Makefile.in.in and
  39.             rerunning configure.
  40.  
  41.     site-start.el    This is loaded each time XEmacs starts up, before the
  42.             user's .emacs file.
  43.  
  44.     default.el    This is loaded each time XEmacs starts up, after the
  45.             user's .emacs file, unless .emacs sets the variable
  46.             inhibit-default-init to t.
  47.  
  48.     version.el    This contains the version information for XEmacs.
  49.  
  50.  
  51. These are the main subdirectories:
  52.  
  53.     prim        Fundamental XEmacs functionality.  Some of this is
  54.             pre-dumped with XEmacs, some is autoloaded.
  55.  
  56.     utils        Various utility functions that some other XEmacs
  57.             packages build on.  These are not user commands.
  58.  
  59.     modes        Text-editing and programming-language-sensitive modes.
  60.  
  61.     emulators    XEmacs can emulate a few different editors.  These are
  62.             a bit more than what `modes' generally are.
  63.  
  64.     term        Terminal-specific customization files.  When XEmacs
  65.             starts, it checks the $TERM environment variable to
  66.             see what type of terminal the user is running on, and
  67.             loads a file named $TERM.el from this directory, if
  68.             that file exists.
  69.  
  70.     vms        VMS-specific code.
  71.  
  72.     x11        X Window System-specific code.
  73.  
  74.     games        Various ways to waste time.
  75.  
  76.     packages    Random other utilities that are not primarily about
  77.             editing text.  For example, code for automatically
  78.             uncompressing .Z files would be here.  This is an
  79.             `everything else' sort of directory.
  80.  
  81. Some packages are fairly large; those have been given their own    directories:
  82.  
  83.     bytecomp    The XEmacs-lisp compiler.
  84.  
  85.     calendar    A calendar and appointment manager.
  86.  
  87.     comint        General code for interacting with inferior processes,
  88.             like shell buffers and lisp interpreters.
  89.  
  90.     dired        The directory editor.
  91.  
  92.     edebug        A source-level debugger for Elisp.
  93.  
  94.     ediff        A comprehensive visual interface to diff and patch.
  95.  
  96.     electric    The "electric" commands; these implement temporary
  97.             windows for help, list-buffers, etc.
  98.  
  99.     energize    An interface to the Lucid Energize system.
  100.  
  101.     eos        An interface to Sun's SparcWorks product.
  102.  
  103.     eterm        A merge of the comint shell mode with an
  104.             ANSI-compatible terminal-emulator.
  105.  
  106.     gnus        An NNTP-based newsreader; version 3.14.
  107.  
  108.     hm--html-menus    Menu interface to html-mode.
  109.  
  110.     hyperbole    An information management and hypertext system.
  111.  
  112.     ilisp        A comint-based package for interacting with inferior
  113.             lisp processes.
  114.  
  115.     mh-e        An interface to the MH-E mail handling system.
  116.  
  117.     oobr        An Object-Oriented class browser.
  118.  
  119.     pcl-cvs        An interface to the Concurrent Version System.
  120.  
  121.     rmail        A BABYL-format mail reader.
  122.  
  123.     sunpro        Additional code for interfacing with SunPro products.
  124.  
  125.     tooltalk    An inteface to the ToolTalk communication protocol.
  126.  
  127.     viper        A full-featured VI emulator.
  128.  
  129.     vm        View Mail, an UNIX-format alternative to RMAIL.
  130.  
  131.     w3        A World Wide Web interface.
  132.